Add long description
authorMatthias Clasen <matthiasc@src.gnome.org>
Mon, 5 Jan 2009 04:19:48 +0000 (04:19 +0000)
committerMatthias Clasen <matthiasc@src.gnome.org>
Mon, 5 Jan 2009 04:19:48 +0000 (04:19 +0000)
svn path=/trunk/; revision=22063

docs/reference/ChangeLog
docs/reference/gtk/tmpl/gtkviewport.sgml

index 1f9ada35f0c1bd2d6b0c9397ad6bf120cadc08b6..d6c5b6bddee304f0f3acef00b47cfd4ae0845c62 100644 (file)
@@ -1,3 +1,10 @@
+2009-01-04  Matthias Clasen  <mclasen@redhat.com>
+
+       Bug 566045 – GtkViewport is lacking a description
+
+       * gtk/tmpl/gtkviewport.sgml: Add some descriptive text, shamelessly
+       copied from gtkscrolledwindow.sgml. Requested by Andrew Cowie.
+
 2009-01-01  Matthias Clasen  <mclasen@redhat.com>
 
        * === Released 2.15.0 ===
index 54eefc0e60384f2eef4a07582129893d10119ff7..c6343cb8e018f19c820abe3823a0cbd09eadec77 100644 (file)
@@ -6,12 +6,24 @@ An adapter which makes widgets scrollable
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
+The #GtkViewport widget acts as an adaptor class, implementing 
+scrollability for child widgets that lack their own scrolling 
+capabilities. Use #GtkViewport to scroll child widgets such as 
+#GtkTable, #GtkBox, and so on.
+</para>
 
+<para>
+If a widget has native scrolling abilities, such as #GtkTextView, 
+#GtkTreeView or #GtkIconview, it can be added to a #GtkScrolledWindow 
+with gtk_container_add(). If a widget does not, you must first add the 
+widget to a #GtkViewport, then add the viewport to the scrolled window. 
+The convenience function gtk_scrolled_window_add_with_viewport() does 
+exactly this, so you can ignore the presence of the viewport.
 </para>
 
 <!-- ##### SECTION See_Also ##### -->
 <para>
-
+#GtkScrolledWindow, #GtkAdjustment
 </para>
 
 <!-- ##### SECTION Stability_Level ##### -->